//
// $Id: WeakReference.as 2 2010-06-09 19:48:43Z ray.j.greenwell $
//
// aspirin library - Taking some of the pain out of Actionscript development.
// Copyright (C) 2007-2010 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/ooo-aspirin/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.util {

import flash.utils.Dictionary;

/**
 * A weak reference. At some point in the future the referent might not be available
 * anymore.
 */
public class WeakReference
{
    /**
     * No, you cannot store undefined here.
     */
    public function WeakReference (referant :Object)
    {
        _ref[referant] = true;
    }

    /**
     * Return the referant, or undefined if it's been collected.
     */
    public function get () :*
    {
        for (var k :* in _ref) {
            return k;
        }
        return undefined;
    }

    /** The only way to have a weak reference in actionscript. */
    protected var _ref :Dictionary = new Dictionary(true);
}
}
